Specifies whether or not the object uses absolute or relative date properties. Absolute date properties are EarliestDate and LatestDate. Options are 0 — No and 1 — Yes. Default is 0 — No.

Relative date properties are EarliestDateCount, EarliestDateUnits, ViewSizeCount, and ViewSizeUnits.

See also Configuring a Date Range.

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If 0 — No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 — No and 1 — Yes. Default is 0 — No. Script subtype is Boolean.

This property is not necessarily related to AlternateUnitsOverride and OverrideAlternateUnits.

See also Configuring a Date Range.

Specifies the name of alternate units used when overriding alternate units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed.

Script subtype is string.

See also OverrideAlternateUnits and Editing a Series.

Specifies the color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

Script subtype is long.

See also MonoAnnotationColor, AnnotationColorFromSeries, Configuring Colors, and Using the Trend Tool in Run Mode.

Enables the color of text annotations in Display Information options to be derived from their corresponding series color. Options are 0 — No and 1 — Yes. Default is 0 — No. When set to 0 — No, the text color for all annotations is specified by AnnotationColor. When set to 1 — Yes, AnnotationColor is ignored and each text annotation is drawn in the color of its corresponding series.

Script subtype is Boolean.

See also Configuring Colors.

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 — Flat or 1 — 3D. Default is 0 — Flat.

Script subtype is Integer.

See also BorderStyle.

Enables the object to automatically retrieve and display new data according to a specified time interval. This appears to extend a trend to the right as it refreshes. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also AutoExtendRateSec and Configuring a Date Range.

Specifies the time interval in seconds by which the object refreshes. Default is 1.

Script subtype is double.

See also AutoExtendEnabled and Configuring a Date Range.

Enables a y-axis to automatically scale according to the value of the data it displays. Available for backwards compatibility only. Use AutoScaleMax and AutoScaleMin instead.

Script subtype is Boolean. (True means that both AutoScaleMax and AutoScaleMin are true.)

This property is axis indexed.

See also AutoScaleMin, AutoScaleMax, and Editing a Y-Axis.

Specifies whether or not the y-axis upper limit automatically scales relative to the data it displays. When activated, overrides MaxY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

Script subtype is Boolean.

See also AutoScale, AutoScaleMin, and Editing a Y-Axis.

Specifies whether or not the y-axis lower limit automatically scales relative to the data it displays. If activated, overrides MinY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

Script subtype is Boolean.

See also AutoScale, AutoScaleMax, and Editing a Y-Axis.

Specifies the total number of configured y-axes in the object. In other words, specifies the upper bound for the XML axis index. This property is read only.

Script subtype is integer.

Specifies the user-defined number (0 — 15) assigned to a y-axis. Once the axis ID number is assigned to a y-axis, the number cannot be changed. If you want to change an axis ID number, you must delete the axis and create a new one from the available axis ID numbers. This property is axis indexed. This property is read only.

Script subtype is integer.

See also Numerical Identifiers.

Specifies the y-axis number with which a specific series is associated. Options are integers that correspond with configured y-axes. This property is series indexed.

Script subtype is integer.

BackColor specifies a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

• For the Dynagraph Control, BackColor specifies the background color for the object, not the background color of the graph (plot area). See GraphBackgroundColor to change the background color of the graph. The default color is gray (RGB 240.240.240).
• For the GCM Nomination Grid, the default color is white (RGB 255.255.255).
• For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors.
• For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long.
• For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long.

See also MonoBackColor and Configuring Colors.

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

• 0 — ibsNone, 1 — ibsRaised, or 2 — ibsLowered, and the default is 0 — ibsNone

• 0 — None or 1 — Fixed Single, and the default is 0 — None

The Panel Switch Tool uses these options:

• 0 — ibsLine, 1 — ibsRaised, 2 — ibsLowered, 3 — ibsTop, and 4 — ibsNone, and the default is 0 — ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

• 0 — Normal, 1 — 3D, 2 — Sunken, 3 — Raised, and 4 — None

The default for the Box Tool is 0 — Normal. The default for the Frame Tool is 1 — 3D. The default for the Text Tool is 4 — None.

If you use 2 — Sunken or 3 — Raised and the effect is not visible, change the object’s HiliteColor.

If you use 0 — Normal, 2 — Sunken, or 3 — Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 — Thin, which means the border is thin and the size is static. The other possible option is 1 — Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects.

Script subtype is integer.

Specifies whether or not a large value on the y-axis uses commas as its numeric divider. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Graph.

Specifies the font size for the Display Information > Value at Cross Hairs option in Run mode. Options are 0 (large), 1 (medium), and 2 (small). Default is 2 (small).

Script subtype is integer.

See also Configuring Font.

Specifies the source of the current date and time used to define the limits of the view window.

Options are as follows:

• 0 — Client Time: Specifies that the view window is created relative to the client current time. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
• 1 — Server Time: Specifies that the view window is created relative to the server (i.e., ARS) current time. If this setting is used but the server time is unavailable, the client time is used for as long as the server time is unavailable. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
• 2 — Series Time: Specifies that the view window is created relative to the most recent time supplied by a series, server, or client. This means that if any series time on a trend is the most recent time of the three possible time sources, the series defines the latest extent of the view window and appears to be in the future. May be used as a way of correcting for time drift or other similar anomalous situations where series data appears to be "ahead" of the local current time.

Default is 0 — Client Time.

Script subtype is integer.

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 — Arrow
• 2 — IBeam
• 3 — Cross
• 4 — UpArrow
• 5 — NoDrop
• 6 — Help
• 99 — HotSpot
• 100 — Timer

Script subtype is long.

Specifies the label name of the toolbar's Button 1. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 8.

Script subtype is string.

See also Configuring a Toolbar.

Specifies the label name of the toolbar's Button 2. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 24.

Script subtype is string.

See also Configuring a Toolbar.

Specifies the label name of the toolbar's Button 3. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 3D.

Script subtype is string.

See also Configuring a Toolbar.

Specifies the time increment by which a trend's view window increases if Button 1 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 1.

Script subtype is integer.

See also CustomUnits.

Specifies the time increment by which a trend's view window increases if Button 2 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 8.

Script subtype is integer.

See also CustomUnits and Configuring a Toolbar.

Specifies the time increment by which a trend's view window increases if Button 3 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 24.

Script subtype is integer.

See also CustomUnits and Configuring a Toolbar.

Specifies the size of a trend's view window in units of time if Button 1 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 8.

Script subtype is integer.

See also CustomUnits and Configuring a Toolbar.

Specifies the size of a trend's view window in units of time if Button 2 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 24.

Script subtype is integer.

See also CustomUnits and Configuring a Toolbar.

Specifies the size of a trend's view window in units of time if Button 3 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 72.

Script subtype is integer.

See also CustomUnits and Configuring a Toolbar.

Specifies a time unit type that corresponds to the values specified for the Custom View Buttons fields View Size and Scroll Size. View Size and Scroll Size use the various CustomSize and CustomScroll properties. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

Script subtype is integer.

See also Configuring a Toolbar.

Specifies the display of a shadow or 3-D effect with certain graph items, like series lines. Options are 0 — None, 1 — 2D, and 2 — 3D. Default is 0 — None.

Script subtype is integer.

See also Configuring a Graph.

Enables a graph to automatically filter out excessive data points. This can improve performance if you are displaying a large amount of data. Typically, the effect of data thinning is not noticeable to a user. However, if MarkDataPoints is enabled, the effect of data thinning might be noticeable. All data points still display upon zoom. Data thinning is currently incompatible with square wave lines.

Options are as follows:

• 0 — Off: Always displays all data points.
• 1 — Basic: Enables quick data thinning, for best performance.
• 2 — Advanced: Enables slow data thinning, which is more thorough than Basic, but performance is not as good.

Default is 1 — Basic.

Script subtype is integer.

See also Configuring a Graph.

Specifies a default facility ID for the object. Default is blank.

Script subtype is string.

See also Configuring Groups, Axes, and Series.

Specifies the default current value service for the object. Default is blank.

Script subtype is string.

See also Configuring Groups, Axes, and Series.

DisplayFont returns the current, resized font values for the object. The correct font size is returned only if AutoSizeFont is enabled. For tools other than Text Tool, DDS Editor Button, SetPoint Button, and UIS Command Button DisplayFont is identical to the Font property, except that this is a font interface object instead of a string.

This property is read only.

Enables you to select one of several special display modes. Most of the following modes affect what happens when a data point on a trend is clicked. Options are 0 — None, 1 — Crosshairs, 2 — Tag, 3 — Timeslice, 4 — Timeslice Table, and 5 — Notes. Default is 0 — None.

Script subtype is integer.

See also Configuring Display Information.

Specifies the earliest (i.e., least recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

Script subtype is variant.

See also AbsoluteDateRange,LatestDate, and Configuring a Date Range.

If the view window date range is relative (that is, not absolute), specifies the number of time units before the current system date and time from which to display trend data. Default is 8.

Script subtype is integer.

See also Configuring a Date Range, EarliestDateUnits, ViewSizeCount, and ViewSizeUnits.

If the view window date range is relative (that is, not absolute), specifies the time unit type for the earliest date and time from which to display trend data. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

Script subtype is integer.

See also Configuring a Date Range, EarliestDateCount, ViewSizeCount, and ViewSizeUnits.

Returns the earliest date and time displayed on a trend.

Script subtype is variant. This property is read only.

See also LatestDisplayedDate.

Currently disabled.

Script subtype is long.

See also Visible.

Enables enhanced trend graphics, including anti-aliased lines and softer colors. Using this option might decrease the object's performance. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Graph.

Places a virtual data point at the current time that reflects the most recently retrieved value. This has the appearance of extending the most recently retrieved (i.e., last) value up to the current time. Can be used in combination with AutoExtendEnabled. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Date Range.

Currently disabled.

Script subtype is string.

This property is series indexed.

See also Editing a Series.

Specifies the color to be used for a trend fill. Used in conjunction with FillEnabled. Default is green (RGB 134.223.53).

Script subtype is long.

See also To Apply Trend Fill.

Enables a solid-color fill area to be drawn between two series on the same y-axis. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also To Apply Trend Fill.

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries2 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

Script subtype is integer.

See also To Apply Trend Fill.

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries1 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

Script subtype is integer.

See also To Apply Trend Fill.

Prevents fonts from increasing in size as the object is resized. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring Font.

If enabled, prevents series line type widths from increasing in size as the object is resized. If disabled, only a subset of available series line types resize as the object resizes. The subset is as follows:

• Medium Solid
• Thick Solid
• Medium Thin Solid
• Medium Thick Solid
• Extra Thick Solid

This property maintains legacy behavior for existing screens. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Graph.

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

Currently disabled.

Script subtype is string.

Specifies the size of textual items on the object relative to the size of the object. Options are 0 — Large, 1 — Medium, and 2 — Small. Default is 1 — Medium.

Script subtype is integer.

See also FixedFonts and Configuring Font.

Specifies the foreground color of textual items outside the object's graph. Default is black (RGB 0.0.0).

Script subtype is long.

See also Configuring Colors.

Specifies the background color of the object's graph. Default is white (RGB 245.245.245).

Script subtype is long.

See also Configuring Colors.

Specifies the use of a border and border style for an object's graph.

Options are as follows:

• 0 — None
• 1 — Thin Line
• 2 — Thick Line
• 3 — Shadow
• 4 — 3D Inset

Default is 1 — Thin Line.

Script subtype is integer.

See also Configuring a Graph.

Specifies the foreground color of the object's graph. Default is dark gray (RGB 128.128.128).

Script subtype is long.

See also Configuring Colors.

Specifies the color of the object's graph shadow. Default is dark gray (RGB 128.128.128). GraphBorderStyle must be set to Shadow in order for GraphShadowColor to take effect.

Script subtype is long.

See also Configuring Colors.

Displays the graph with a banded-background view for improved visibility. The GraphBackColor property changes the band colors. Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Graph.

Specifies whether or not to have grid lines appear in front of series lines or behind series lines. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring a Graph.

Script subtype is integer.

See also GridStyle and Configuring a Graph.

Specifies whether or not grid lines are displayed on the object's graph. Options are 0 — Both, 1 — Y Axis, 2 — X Axis, and 3 — None. Default is 0 — Both.

Specifies the style of grid lines displayed on the object's graph. Options are 0 — Thin Lines, 1 — Thick Lines, 2 — Dotted Lines, and 3 — Dashed Lines. Default is 2 — Dotted Lines.

Script subtype is integer.

See also GridLines and Configuring a Graph.

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 — No and 1 — Yes. The default is 0 — No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group.

5. Set Group set to 0 — No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

Specifies the GroupID of the object group.

This property is read only.

Script subtype is long.

Returns a Boolean value to confirm a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Returns a Boolean value to confirm whether or not a y-axis has no series assigned to it. True indicates that a y-axis has no series assigned to it. If true, the y-axis is not displayed in Run mode. This property is axis indexed. This property is read only.

Script subtype is Boolean.

See also DisplayedToConfiguredAxis.

Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.

Specifies whether or not keyboard shortcuts are enabled. Options are 0 — No and 1 — Yes. The default is 1 — Yes.

Script subtype is Boolean.

Specifies the trend label font type. It does not apply to title and sub-title font. Default is Arial.

Script subtype is string.

See also Configuring Font.

Specifies whether or not label font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not label font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not label font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies the latest (i.e., most recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

Script subtype is variant.

See also AbsoluteDateRange, Configuring a Date Range, and EarliestDate.

Returns the latest date and time displayed on a trend.

Script subtype is variant. This property is read only.

See also EarliestDisplayedDate.

Layer identifies the layer on which the object resides. Script subtype is Boolean.

LayerId is a script property that specifies the layer on which the object resides. Options vary depending on the names of existing layers. Default is Default.

Script subtype is long.

See also Using Layers.

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects.

Script subtype is long.

Returns and displays the legend string appropriate to that defined by token substitution.

Script subtype is string.

This property is read only.

See also LegendFormatStr.

Specifies various number-based legend formatting options. Exposed for legacy support. Default is 0.

Script subtype is long.

Specifies the tokenized legend format. Default is %longdescription%.

Script subtype is string.

See also Legend and Configuring a Legend.

Specifies the location of the legend relative to the graph. Options are 0 — None, 1 — Top, 2 — Bottom, 3 — Left, and 4 — Right. Default is 2 — Bottom.

Script subtype is integer.

See Configuring a Legend.

Specifies whether or not to have a legend item's series icon outlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See Configuring a Legend.

Specifies a legend format that overrides the one specified by LegendFormatStr on a per-series basis. You can specify a tokenized legend format or user-defined text. This property is series indexed.

Script subtype is string.

See also Editing a Series.

Specifies the line appearance and/or size for a single series line.

Options are as follows:

• 0 — Thin Solid
• 1— Dashed
• 2 — Dotted
• 3 — Dash Dot
• 4 — Dash Dot Dot
• 5 — Medium Solid
• 6 — Thick Solid
• 7 — Medium Thin Solid
• 8 — Medium Thick Solid
• 9 — Extra Thick Solid
• 10 — Extra Thin Solid
• 11 — Extra-Extra Thin Solid

Default is 0 — Thin Solid. This property is series indexed.

Script subtype is integer.

See also PlotStyle, FixedLineWidth, and Editing a Series.

Specifies whether or not to have solid black dots drawn at data points. This property is not related to PointType. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also MaximumPointSize and Configuring a Graph.

Specifies the setting of an upper limit for the size of data points. This ensures that points do not scale to an unreasonably large size. Only works if MarkDataPoints is set to 1 — Yes.

Options are as follows:

• 0 — None: Places no upper boundary on the size of a data point. Data points continue to increase in size as a trend tool is expanded.
• 1 — Small: Ensures that data points scale within a range appropriate to a small point. Scales to a maximum size of 2 pixels.
• 2 — Medium: Ensures that data points scale within a range appropriate to a medium point. Scales to a maximum size of 6 pixels.
• 3 — Large: Ensures that data points scale within a range appropriate to a large point. Scales to a maximum size of 10 pixels.

Default is 3 — Large.

Script subtype is integer.

See also MarkDataPoints and Configuring a Graph.

Specifies the user-defined upper limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMax is enabled. This property is axis indexed.

Script subtype is double.

See also MinY and Editing a Y-Axis.

Specifies the user-defined lower limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMin is enabled. This property is axis indexed.

Script subtype is double.

See also MaxY and Editing a Y-Axis.

Specifies the grayscale color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. Useful with black and white or grayscale printers. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

Script subtype is long.

See also AnnotationColor, AnnotationColorFromSeries, Configuring Colors, and Using the Trend Tool in Run Mode.

Specifies the grayscale color of the trend's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

Script subtype is long.

See also BackColor and Configuring Colors.

Specifies the grayscale color of the trend's foreground. Useful with black and white or grayscale printers. Default is black (RGB 0.0.0).

Script subtype is long.

See also ForeColor and Configuring Colors.

Specifies the grayscale color of the graph's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

Script subtype is long.

See also GraphBackColor and Configuring Colors.

Specifies the grayscale color of the graph's foreground. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

Script subtype is long.

See also GraphForeColor and Configuring Colors.

Specifies the grayscale color of the graph's shadow. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

Script subtype is long.

See also GraphShadowColor and Configuring Colors.

Specifies a filter by which to sort and display notes on trend. On the Property Sheet, you can manually enter a filter. You can also use the Set Note Rules dialog box to do so. Default is blank.

Script subtype is string.

See also Configuring Display Information.

Specifies the number of decimal places to display for the Display Information > Value at Cross Hairs option in Run mode. Default is 3.

Script subtype is integer.

See also Configuring a Graph.

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

Displays the OCXProperty dialog box unique to the object.

Specifies the position of a y-axis label relative to the graph. If set to false, position is to the left of a y-axis. This property is axis indexed.

Script subtype is Boolean.

See also Editing a Y-Axis.

Specifies whether or not a y-axis belongs to the same axis group as the y-axis previous to it. This property is axis indexed.

Script subtype is Boolean.

Enables a user to override the alternate units derived from the point configuration record on a per-series basis. This property is series indexed.

Script subtype is Boolean.

See also AlternateUnitsOverride and Editing a Series.

Enables a user to override the primary units derived from the point configuration record on a per-series basis. This property is series indexed.

Script subtype is Boolean.

See also PrimaryUnitsOverride and Editing a Series.

Specifies whether or not a series displays in a square wave. MarkDataPoints must be enabled for PlotSquareWave to take effect. This property is series indexed.

Script subtype is Boolean.

See also Editing a Series.

Specifies the appearance of series on a per-y-axis basis. Default is 0 — Line. This property is axis indexed.

Options are as follows:

• 0 — Line
• 1 — Bar
• 2 — Points
• 3 — Area
• 4 — Points + Best Fit Curve
• 5 — Points + Best Fit Line
• 6 — Points + Line
• 7 — Points + Spline
• 8 — Spline

Using points plot styles (for instance, Points + Line) in conjunction with PlotSquareWave or ExtendLastValue might result in inauthentic points for the purposes of enabling those options. Conversely, using points plot styles in conjunction with DataThinning might result in fewer displayed data points.

Script subtype is integer.

See also Plot Style Examples and Editing a Y-Axis.

Specifies the point ID of the tag for which a series is to display information. This property is series indexed.

Script subtype is string.

See also Editing a Series.

Specifies the long point ID of the tag for which a series is to display information. This property is series indexed.

Script subtype is string.

See also Editing a Series.

Specifies the shape of a data point icon for a series. The series's assigned y-axis must be set to a PlotStyle that includes points (for instance, Points, Points + Best Fit Curve, Points + Best Fit Line, Points + Line, or Points + Spline). This property is series indexed.

Options are as follows:

• 0 — Plus
• 1 — Cross
• 2 — Circle
• 3 — Solid Circle
• 4 — Square
• 5 — Solid Square
• 6 — Diamond
• 7 — Solid Diamond
• 8 — Upward Triangle
• 9 — Solid Up Triangle
• 10 — Downward Triangle
• 11 — Solid Down Triangle

Default is 3 — Solid Circle.

Script subtype is integer.

See also Editing a Series.

Specifies the name of primary units used when overriding primary units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed. Default is 3 — Solid Circle.

Script subtype is string.

See also OverridePrimaryUnits and Editing a Series.

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

Script subtype is string.

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects.

Script subtype is long.

Specifies the time interval by which a rollup type takes place. This property is series indexed. See History Rollups for more information.

Script subtype is integer.

See also RollupUnits, RollupType, TopOfSubUnit, and Editing a Series.

Specifies the type by which to roll up data for a selected point. This property is series indexed.

Options are as follows:

• 0 — None
• 1 — Calculated Weighted Average
• 2 — Calculated Mean
• 3 — Calculated Minimum
• 4 — Calculated Maximum
• 5 — Calculated Delta
• 6 — Calculated Last
• 7 — Thin Median
• 8 — Thin Minimum/Maximum
• 9 — Thin Last

Default is 0 — None.

Using RollupType might be preferable to using DataThinning because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to DataThinning.

See History Rollups for more information.

Script subtype is integer.

See also RollupUnits, RollupPeriod, and Editing a Series.

Specifies the time units by which a rollup takes place. This property is series indexed.

Options are as follows:

• 0 — None
• 1 — Minutes
• 2 — Hours
• 3 — Days
• 4 — Seconds

Default is 0 — None.

See History Rollups for more information.

Script subtype is integer.

See also RollupType, RollupPeriod, TopOfSubUnit, and Editing a Series.

Currently disabled.

Script subtype is double.

Specifies the number of time units by which to scroll forwards and backwards along a graph.

Script subtype is integer.

See also ScrollUnits and Configuring a Date Range.

Specifies the time unit type by which to scroll forwards and backwards along a graph. Default is 2 — Hours.

Options are as follows:

• 0 — Seconds
• 1 — Minutes
• 2 — Hours
• 3 — Days
• 4 — Weeks
• 5 — Years

Script subtype is integer.

See also ScrollCount and Configuring a Date Range.

Specifies a color for a single series. This property is series indexed.

Script subtype is long.

See also UseAlarmColor and Editing a Series.

Specifies the total number of configured series in a trend. In other words, specifies the upper bound for the XML series index.

Script subtype is integer.

This property is read only.

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

Script subtype is string.

Enables unreliable values to be included in series. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring a Date Range.

Specifies the site and service of the tag for which a series is to display information. The format of the value is Site.Service. This property is series indexed.

Script subtype is string.

See also Editing a Series.

Specifies the subtitle of the object. The subtitle is displayed at the top of the object, but below the title. Default is blank.

Script subtype is string.

See also Configuring a Graph.

Enables the display of the date range specified for the graph. If enabled, the date range displays below the title and beside the subtitle (if a subtitle is specified). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is Boolean.

See also Configuring a Graph.

Specifies the object subtitle font type. It does not apply to title and label font. Default is Arial.

Script subtype is string.

See also Configuring Font.

Specifies whether or not subtitle font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not subtitle font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not subtitle font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

See also Group and Tab Order.

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Specifies the title of the trend. The title is displayed at the top of the trend. Default is blank.

Script subtype is string.

See also Configuring a Graph.

Specifies the trend title font type. It does not apply to subtitle and label font. Default is Arial.

Script subtype is string.

See also Configuring Font.

Specifies whether or not title font is bold. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not title font is italic. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies whether or not title font is underlined. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also Configuring Font.

Specifies the location of the toolbar relative to the graph. Options are 0 — None, 1 — Top, and 2 — Bottom. Default is 0 — None.

Script subtype is integer.

See also Configuring a Toolbar.

TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text.

For information about building dynamic text using tokens, see Using Text Tokens.

Script subtype is string.

Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution.

Script subtype is string.

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects.

Script subtype is string.

TopOfSubUnit specifies the interval by which a rollup takes place by an additional unit of magnitude smaller than that specified by RollupUnits. Subunit means whatever unit of time is the next smaller than that specified for RollupUnits. This property is series indexed.

Script subtype is integer.

See also RollupUnits, RollupPeriod and Editing a Series.

Specifies the file name for the object and is present for backwards compatibility. Default is blank.

Script subtype is string.

Specifies the UDC of the tag for which a series is to display information. This property is series indexed.

Script subtype is string.

See also Editing a Series.

Specifies the use of CygNet point state colors for a single series. Only takes effect if a trend is displaying one series.

Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also SeriesColor, Configuring Colors, Customizing Point State Colors, and Alarms.

Enables the Trend object to use the [Facility] property of TheView rather than its own. Default is 0 — No.

Options are 0 - No and 1 - Yes.

Script subtype is Boolean.

Enables the Trend object to use the [SiteService] property of TheView rather than its own. Default is 0 — No.

Options are 0 - No and 1 - Yes.

Script subtype is Boolean.

Enables the object to use the [Units] property of TheView or the parent view (for the Nested View Tool) rather than its own units. Default is 0 — No.

Options are 0 - No and 1 - Yes.

Script subtype is Boolean.

Specifies the name of a VHS used to override a series's default VHS. Can only be used on a series-by-series basis. Default is blank. This property is series indexed.

Script subtype is string.

See also Editing a Series.

If the view window date range is relative (that is, not absolute), specifies the size (in number of time units) of the view window. Default is 8.

Script subtype is integer.

See also ViewSizeUnits, EarliestDateCount, EarliestDateUnits, and Configuring a Date Range.

If the view window date range is relative (that is, not absolute), specifies the time unit type for the view window. Options are 0 — Seconds, 1 — Minutes, 2 — Hours, 3 — Days, 4 — Weeks, and 5 — Years. Default is 2 — Hours.

Script subtype is integer.

See also ViewSizeCount, EarliestDateCount, EarliestDateUnits, and Configuring a Date Range.

Specifies whether or not the object displays in color or grayscale. Options are 0 — Color, 1 — Monochrome, and 2 — Monochrome + Symbols. Default is 0 — Color.

Script subtype is integer.

See also Configuring Colors.

Specifies whether or not an object in a trend is displayed in Run mode.

Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

Specifies the x-axis label for the object. Default is blank.

Script subtype is string.

See also Configuring a Graph.

Specifies a user-defined y-axis label. It is specified on an axis-by-axis basis. Default is blank. This property is axis indexed.

Script subtype is string.

See also YAxisLabelFromLegend and Editing a Y-Axis.

Specifies whether or not the color of the y-axis label and the y-axis scale are determined by SeriesColor. Alternatively, you can specify the y-axis color using ForeColor. YAxisLabelColorFromSeries is overridden by UseAlarmColor, if UseAlarmColor is enabled. Options are 0 — No and 1 — Yes. Default is 0 — No. This property is axis indexed.

Script subtype is Boolean.

See also ForeColor, SeriesColor, UseAlarmColor, and Configuring Colors.

Specifies whether or not a y-axis label derives from its respective series legend. If not, can be user defined or blank. Options are 0 — No and 1 — Yes. Default is 0 — No.

Script subtype is Boolean.

See also YAxisLabel and Editing a Y-Axis.

Specifies the scale type of a y-axis.

Options are as follows:

• 0 — Automatic: If the data range is larger than or equal to 10e3 and all values are greater than zero, then a log scale is used. Otherwise, a linear scale is used.
• 1 — Linear: A linear scale is used.
• 2 — Logarithmic: A logarithmic scale is used if all values are greater than zero. Otherwise, a linear scale is used.

Default is 1 — Linear.

Script subtype is long.

See also Editing a Y-Axis.